<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iicps: xiicps_slave_monitor_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">iicps
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xiicps__slave__monitor__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">xiicps_slave_monitor_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>A design example of using the device as master to check slave's availability. </p>
<dl class="section note"><dt>Note</dt><dd>Please set the slave address to 0x3FB, which tests the device's ability to handle 10-bit address.</dd></dl>
<pre> MODIFICATION HISTORY:</pre><pre>Ver   Who Date     Changes
<hr/>

1.00a jz  01/30/10 First release</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac8a7f7576834a4b28894a539cdf40dd0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#ac8a7f7576834a4b28894a539cdf40dd0">SLV_MON_LOOP_COUNT</a>&#160;&#160;&#160;0x000FFFFF</td></tr>
<tr class="memdesc:ac8a7f7576834a4b28894a539cdf40dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slave Monitor Loop Count.  <a href="#ac8a7f7576834a4b28894a539cdf40dd0">More...</a><br /></td></tr>
<tr class="separator:ac8a7f7576834a4b28894a539cdf40dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a99e805d8b47d5cd94c9b1ccdd9f4ead8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#a99e805d8b47d5cd94c9b1ccdd9f4ead8">IicPsSlaveMonitorExample</a> ()</td></tr>
<tr class="memdesc:a99e805d8b47d5cd94c9b1ccdd9f4ead8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks the availability of a slave using slave monitor mode.  <a href="#a99e805d8b47d5cd94c9b1ccdd9f4ead8">More...</a><br /></td></tr>
<tr class="separator:a99e805d8b47d5cd94c9b1ccdd9f4ead8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the Slave Monitor example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br /></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a19d9dd848a431a459bff8db6e3eb2985"><td class="memItemLeft" align="right" valign="top">volatile u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#a19d9dd848a431a459bff8db6e3eb2985">TransmitComplete</a></td></tr>
<tr class="memdesc:a19d9dd848a431a459bff8db6e3eb2985"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to check completion of Transmission.  <a href="#a19d9dd848a431a459bff8db6e3eb2985">More...</a><br /></td></tr>
<tr class="separator:a19d9dd848a431a459bff8db6e3eb2985"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f1fae969d865449aacad8208e70ce16"><td class="memItemLeft" align="right" valign="top">volatile u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#a9f1fae969d865449aacad8208e70ce16">ReceiveComplete</a></td></tr>
<tr class="memdesc:a9f1fae969d865449aacad8208e70ce16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to check completion of Reception.  <a href="#a9f1fae969d865449aacad8208e70ce16">More...</a><br /></td></tr>
<tr class="separator:a9f1fae969d865449aacad8208e70ce16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa443a47eeb2dc837aa355392c701f05e"><td class="memItemLeft" align="right" valign="top">volatile u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#aa443a47eeb2dc837aa355392c701f05e">TotalErrorCount</a></td></tr>
<tr class="memdesc:aa443a47eeb2dc837aa355392c701f05e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total Error Count Flag.  <a href="#aa443a47eeb2dc837aa355392c701f05e">More...</a><br /></td></tr>
<tr class="separator:aa443a47eeb2dc837aa355392c701f05e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26357f5bac9c7de1ec13adfcd10df0bc"><td class="memItemLeft" align="right" valign="top">volatile u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#a26357f5bac9c7de1ec13adfcd10df0bc">SlaveResponse</a></td></tr>
<tr class="memdesc:a26357f5bac9c7de1ec13adfcd10df0bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slave Response Flag.  <a href="#a26357f5bac9c7de1ec13adfcd10df0bc">More...</a><br /></td></tr>
<tr class="separator:a26357f5bac9c7de1ec13adfcd10df0bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a794f7fc4c717cbddb196c85003c6d317"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiicps__slave__monitor__example_8c.html#a794f7fc4c717cbddb196c85003c6d317">SlvAddr</a> [] = {0x54,0x55,0x74,0}</td></tr>
<tr class="memdesc:a794f7fc4c717cbddb196c85003c6d317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Searching for the required Slave Address and user can also add their own slave Address in the below array list.  <a href="#a794f7fc4c717cbddb196c85003c6d317">More...</a><br /></td></tr>
<tr class="separator:a794f7fc4c717cbddb196c85003c6d317"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac8a7f7576834a4b28894a539cdf40dd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8a7f7576834a4b28894a539cdf40dd0">&#9670;&nbsp;</a></span>SLV_MON_LOOP_COUNT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SLV_MON_LOOP_COUNT&#160;&#160;&#160;0x000FFFFF</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Slave Monitor Loop Count. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a99e805d8b47d5cd94c9b1ccdd9f4ead8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e805d8b47d5cd94c9b1ccdd9f4ead8">&#9670;&nbsp;</a></span>IicPsSlaveMonitorExample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int IicPsSlaveMonitorExample </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function checks the availability of a slave using slave monitor mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the Device ID of the IicPs Device and is the XPAR_&lt;IICPS_instance&gt;_DEVICE_ID value from xparameters.h</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xiicps__slave__monitor__example_8c.html#a794f7fc4c717cbddb196c85003c6d317">SlvAddr</a>.</p>

<p class="reference">Referenced by <a class="el" href="xiicps__slave__monitor__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a840291bc02cba5474a4cb46a9b9566fe">&#9670;&nbsp;</a></span>main()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the Slave Monitor example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xiicps__slave__monitor__example_8c.html#a99e805d8b47d5cd94c9b1ccdd9f4ead8">IicPsSlaveMonitorExample()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a9f1fae969d865449aacad8208e70ce16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f1fae969d865449aacad8208e70ce16">&#9670;&nbsp;</a></span>ReceiveComplete</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile u8 ReceiveComplete</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flag to check completion of Reception. </p>

</div>
</div>
<a id="a26357f5bac9c7de1ec13adfcd10df0bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26357f5bac9c7de1ec13adfcd10df0bc">&#9670;&nbsp;</a></span>SlaveResponse</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile u32 SlaveResponse</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Slave Response Flag. </p>

</div>
</div>
<a id="a794f7fc4c717cbddb196c85003c6d317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a794f7fc4c717cbddb196c85003c6d317">&#9670;&nbsp;</a></span>SlvAddr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 SlvAddr[] = {0x54,0x55,0x74,0}</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Searching for the required Slave Address and user can also add their own slave Address in the below array list. </p>

<p class="reference">Referenced by <a class="el" href="xiicps__slave__monitor__example_8c.html#a99e805d8b47d5cd94c9b1ccdd9f4ead8">IicPsSlaveMonitorExample()</a>.</p>

</div>
</div>
<a id="aa443a47eeb2dc837aa355392c701f05e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa443a47eeb2dc837aa355392c701f05e">&#9670;&nbsp;</a></span>TotalErrorCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile u32 TotalErrorCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Total Error Count Flag. </p>

</div>
</div>
<a id="a19d9dd848a431a459bff8db6e3eb2985"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19d9dd848a431a459bff8db6e3eb2985">&#9670;&nbsp;</a></span>TransmitComplete</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile u8 TransmitComplete</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flag to check completion of Transmission. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
